package com.mf.ergate.api.cust;

import com.mf.ergate.api.ApiConfig;
import com.mf.ergate.api.cust.model.dto.CustomerAddressCreateDto;
import com.mf.ergate.api.cust.model.dto.CustomerAddressDeleteDto;
import com.mf.ergate.api.cust.model.dto.CustomerAddressQueryDto;
import com.mf.ergate.api.cust.model.dto.CustomerAddressUpdateDto;
import com.mf.ergate.api.cust.model.vo.CustomerAddressVo;
import com.mf.framework.common.model.Page;
import com.mf.framework.common.model.RemotePage;
import com.mf.framework.common.model.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import java.util.List;

/**
 * 客户地址薄RemoteService层接口类
 * User: zhaoming
 * DateTime: 2019-01-27
 * To change this template use File | Settings | File Templates.
 **/
@Api(value = "/api/customerAddress", tags = "CustomerAddressController", description = "客户地址薄服务")
@FeignClient(name= ApiConfig.SERVICE_NAME)
@RequestMapping("/api/customerAddress")
public interface CustomerAddressRemoteService{

    /**
     * 新增
     * @param customerAddressCreateDto 客户地址薄新增Dto
     * @return 客户地址薄
     */
    @ApiOperation(value = "新增")
    @ApiImplicitParam(name = "customerAddressCreateDto", value = "客户地址薄新增Dto", dataType = "CustomerAddressCreateDto",  required = true, paramType = "body")
    @RequestMapping(value = "/insert", method = RequestMethod.POST)
    Result<CustomerAddressVo> insert(@RequestBody CustomerAddressCreateDto customerAddressCreateDto);

    /**
     * 根据唯一编号更新
     * @param customerAddressUpdateDto 客户地址薄更新Dto
     * @return 执行结果
     */
    @ApiOperation(value = "根据唯一编号更新")
    @ApiImplicitParam(name = "customerAddressUpdateDto", value = "客户地址薄更新Dto", dataType = "CustomerAddressUpdateDto",  required = true, paramType = "body")
    @RequestMapping(value = "/updateByUniqueNo", method = RequestMethod.POST)
    Result<Boolean> updateByUniqueNo(@RequestBody CustomerAddressUpdateDto customerAddressUpdateDto);

    /**
     * 根据唯一编号删除(逻辑删除)
     * @param customerAddressDeleteDto 客户地址薄删除Dto
     * @return 执行结果
     */
    @ApiOperation(value = "根据唯一编号删除(逻辑删除)")
    @ApiImplicitParam(name = "customerAddressDeleteDto", value = "客户地址薄删除Dto", dataType = "CustomerAddressDeleteDto",  required = true, paramType = "body")
    @RequestMapping(value = "/deleteByUniqueNo", method = RequestMethod.POST)
    Result<Boolean> deleteByUniqueNo(@RequestBody CustomerAddressDeleteDto customerAddressDeleteDto);

    /**
     * 根据唯一编号查询
     * @param uniqueNo 唯一编号
     * @return 客户地址薄
     */
    @ApiOperation(value = "根据唯一编号查询")
    @ApiImplicitParam(name = "uniqueNo", value = "唯一编号", dataType = "String",  required = true, paramType = "body")
    @RequestMapping(value = "/selectByUniqueNo", method = RequestMethod.POST)
    Result<CustomerAddressVo> selectByUniqueNo(@RequestBody String uniqueNo);

    /**
     * 根据条件查询
     * @param customerAddressQueryDto 客户地址薄查询Dto
     * @return 客户地址薄列表
     */
    @ApiOperation(value = "根据条件查询")
    @ApiImplicitParam(name = "customerAddressQueryDto", value = "客户地址薄查询Dto", dataType = "CustomerAddressQueryDto",  required = true, paramType = "body")
    @RequestMapping(value = "/selectByCondition", method = RequestMethod.POST)
    Result<List<CustomerAddressVo>> selectByCondition(@RequestBody CustomerAddressQueryDto customerAddressQueryDto);

    /**
     * 根据条件查询数量
     * @param customerAddressQueryDto 客户地址薄查询Dto
     * @return 数量
     */
    @ApiOperation(value = "根据条件查询数量")
    @ApiImplicitParam(name = "customerAddressQueryDto", value = "客户地址薄查询Dto", dataType = "CustomerAddressQueryDto",  required = true, paramType = "body")
    @RequestMapping(value = "/selectCount", method = {RequestMethod.POST})
    Result<Integer> selectCount(@RequestBody CustomerAddressQueryDto customerAddressQueryDto);

    /**
     * 根据条件分页查询
     * @param remotePage 远程分页
     * @return 客户地址薄分页列表
     */
    @ApiOperation(value = "根据条件分页查询")
    @ApiImplicitParam(name = "remotePage", value = "远程分页", dataType = "RemotePage",  required = true, paramType = "body")
    @RequestMapping(value = "/selectPage", method = {RequestMethod.POST})
    Result<Page<CustomerAddressVo>> selectPage(@RequestBody RemotePage<CustomerAddressQueryDto> remotePage);
}
